home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / tabx10.zip / TABX.DOC < prev    next >
Text File  |  1990-03-03  |  5KB  |  133 lines
  1.            TABX  - tab expansion utility
  2.           ===============================
  3.  
  4.     The basic function of the TABX utility is to that expands TAB characters
  5.     to SPACES. The program works as a filter, that means that it can handle
  6.     files of arbitrary size, as big as your disk will allow.
  7.     The input is taken form the 'standard input' and output is written
  8.     to the 'standard output'. By default standard input is the keyboard
  9.     and standard output is the screen.
  10.     In order to work with files a redirection of input and output is
  11.     necessary. The following line demonstrates how to use TABX when the
  12.     input file is named 'input' and the output file is named 'output':
  13.  
  14.       TABX  < INPUT  > OUTPUT
  15.  
  16.     In addition to tab expansion TABX can do case conversion, eliminate
  17.     excessive blank characters and add line numbers.
  18.     These options are described below.
  19.  
  20.     Tab spacing can be set in two ways:
  21.  
  22.     1. Fixed tab spacing:
  23.        Tabs are expanded to spaces, up to a multiple of the spacing.
  24.  
  25.          TABX  3   < a:input  >c:\txt\output
  26.  
  27.        Will set tab stops in columns 3,6,9 etc. there is
  28.        no limit to line length.
  29.        The default tab spacing is 8.
  30.  
  31.     2. User defined tab spacing:
  32.        Tab stops are set according to a tab specification string:
  33.  
  34.           TABX --T----T------T-    < aaa > bbb
  35.  
  36.        This will set tab stops at columns 3,8,15.
  37.        When the input line is longer the the tab specification string,
  38.        tab stops of the excessive characters will be set to default
  39.        fixed spacing.
  40.        In the specification string, 't' can replace 'T' in setting tab stops,
  41.        any other character can replace the '-' characters above.
  42.  
  43.  
  44.     Each TAB character is expanded to at least one space character.
  45.  
  46.  
  47.     Other options:
  48.  
  49.         TABX [-flags] [tab_specification]  < infile > output
  50.  
  51.        The following flags may be specified:
  52.  
  53.           -e  Excessive blank characters are removed from end of lines.
  54.           -n  Line numbers are inserted at the beginning of lines.
  55.           -u  Convert all character to upper case.
  56.           -l  Convert all character to lower.
  57.           -c  Capitalize words in the file.
  58.           -s  strip bit 8 from all characters.
  59.  
  60.     Options, fixed tab spacing and tab spec string may appear in any
  61.     order on the command line.
  62.  
  63.      The following will add line numbers in addition to expanding tabs:
  64.  
  65.         TABX -l 5  < in > out
  66.  
  67.  
  68.  
  69.  
  70.     Usage summery is available by running
  71.  
  72.        TABX  ?
  73.  
  74.  
  75.  
  76.    More about options
  77.  
  78.        In addition to expanding tab characters TABX can perform several
  79.        other operation on the text that is flowing through it.
  80.        Each option may be viewed as a filter, with an input and output
  81.        connections. Filters are connected by pipes in the same way a water
  82.        (or sewerage) system is made (somewhat resembling unix).
  83.  
  84.        The data stream is entering the system from the standard input,
  85.        then it is going through the filter that expand every tab to spaces.
  86.        The result stream may flow through optional filters and, finally,
  87.        it is going out to the standard output.
  88.  
  89.        The optional filters are connecter by specifying options in the
  90.        command line. The order of the filters is important, and is determined
  91.        by the order of the flags in the command line.
  92.  
  93.        For example:
  94.  
  95.           TABX -lc < in > out
  96.  
  97.        Will create the following piping:
  98.  
  99.        input         expand          convert         make           output
  100.        file   ===>   tabs to  ===>   to lower  ===>  capital  ===>  file
  101.        'in'          spaces          case            starts         'out'
  102.  
  103.        This will convert every letter to lower case, and then
  104.        capitalize start of sentences only.
  105.  
  106.        On the other hand,
  107.  
  108.           TABX -cl < in > out
  109.  
  110.        Would result in capitalization first and converting all characters
  111.        to lower case later. The result will be a file with lower case letters
  112.        only.
  113.  
  114.  
  115.  
  116.   COPYRIGHT & DISTRIBUTION
  117.  
  118.     Copyright -  Baruch Nissenbaum,  Israel, 1990.
  119.  
  120.     This program and its source code may be copied by anybody,
  121.     for any purpose, as long as the following two terms will be kept:
  122.  
  123.     1. The program will be distributed FREE OF ANY CHARGE whatsoever.
  124.        In particular, it is forbidden to include the program in any package
  125.        that costs money.
  126.     2. This message will be distributed/copied along with the program.
  127.  
  128.  
  129.  Comments, suggestions and ideas are welcomed, at:
  130.  baruch@taunivm.bitnet (taunivm.tau.ac.il) or baruch@taueng.tau.ac.il
  131.  
  132. baruch.
  133.